home *** CD-ROM | disk | FTP | other *** search
/ Visual Cafe 3 / Visual Cafe 3.ISO / Vcafe / Main.bin / AppletContext.java < prev    next >
Text File  |  1998-09-22  |  5KB  |  138 lines
  1. /*
  2.  * @(#)AppletContext.java    1.23 98/07/01
  3.  *
  4.  * Copyright 1995-1998 by Sun Microsystems, Inc.,
  5.  * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
  6.  * All rights reserved.
  7.  * 
  8.  * This software is the confidential and proprietary information
  9.  * of Sun Microsystems, Inc. ("Confidential Information").  You
  10.  * shall not disclose such Confidential Information and shall use
  11.  * it only in accordance with the terms of the license agreement
  12.  * you entered into with Sun.
  13.  */
  14.  
  15. package java.applet;
  16.  
  17. import java.awt.Image;
  18. import java.awt.Graphics;
  19. import java.awt.image.ColorModel;
  20. import java.net.URL;
  21. import java.util.Enumeration;
  22.  
  23. /**
  24.  * This interface corresponds to an applet's environment: the 
  25.  * document containing the applet and the other applets in the same 
  26.  * document. 
  27.  * <p>
  28.  * The methods in this interface can be used by an applet to obtain 
  29.  * information about its environment. 
  30.  *
  31.  * @author     Arthur van Hoff
  32.  * @version     1.23, 07/01/98
  33.  * @since       JDK1.0
  34.  */
  35. public interface AppletContext {
  36.     /**
  37.      * Creates an audio clip. 
  38.      *
  39.      * @param   url   an absolute URL giving the location of the audio clip.
  40.      * @return  the audio clip at the specified URL.
  41.      * @since   JDK1.0
  42.      */
  43.     AudioClip getAudioClip(URL url);
  44.  
  45.     /**
  46.      * Returns an <code>Image</code> object that can then be painted on 
  47.      * the screen. The <code>url</code> argument<code> </code>that is 
  48.      * passed as an argument must specify an absolute URL. 
  49.      * <p>
  50.      * This method always returns immediately, whether or not the image 
  51.      * exists. When the applet attempts to draw the image on the screen, 
  52.      * the data will be loaded. The graphics primitives that draw the 
  53.      * image will incrementally paint on the screen. 
  54.      *
  55.      * @param   url   an absolute URL giving the location of the image.
  56.      * @return  the image at the specified URL.
  57.      * @see     java.awt.Image
  58.      * @since   JDK1.0
  59.      */
  60.     Image getImage(URL url);
  61.  
  62.     /**
  63.      * Finds and returns the applet in the document represented by this 
  64.      * applet context with the given name. The name can be set in the 
  65.      * HTML tag by setting the <code>name</code> attribute. 
  66.      *
  67.      * @param   name   an applet name.
  68.      * @return  the applet with the given name, or <code>null</code> if
  69.      *          not found.
  70.      * @since   JDK1.0
  71.      */
  72.     Applet getApplet(String name);
  73.  
  74.     /**
  75.      * Finds all the applets in the document represented by this applet 
  76.      * context. 
  77.      *
  78.      * @return  an enumeration of all applets in the document represented by
  79.      *          this applet context.
  80.      * @since   JDK1.0
  81.      */
  82.     Enumeration getApplets();
  83.  
  84.     /**
  85.      * Replaces the Web page currently being viewed with the given URL. 
  86.      * This method may be ignored by applet contexts that are not 
  87.      * browsers. 
  88.      *
  89.      * @param   url   an absolute URL giving the location of the document.
  90.      * @since   JDK1.0
  91.      */
  92.     void showDocument(URL url);
  93.  
  94.     /**
  95.      * Requests that the browser or applet viewer show the Web page 
  96.      * indicated by the <code>url</code> argument. The 
  97.      * <code>target</code> argument indicates in which HTML frame the 
  98.      * document is to be displayed. 
  99.      * The target argument is interpreted as follows:
  100.      * <p>
  101.      * <center><table border="3"> 
  102.      * <tr><td><code>"_self"</code>  <td>Show in the window and frame that 
  103.      *                                   contain the applet.</tr>
  104.      * <tr><td><code>"_parent"</code><td>Show in the applet's parent frame. If 
  105.      *                                   the applet's frame has no parent frame, 
  106.      *                                   acts the same as "_self".</tr>
  107.      * <tr><td><code>"_top"</code>   <td>Show in the top-level frame of the applet's 
  108.      *                                   window. If the applet's frame is the 
  109.      *                                   top-level frame, acts the same as "_self".</tr>
  110.      * <tr><td><code>"_blank"</code> <td>Show in a new, unnamed
  111.      *                                   top-level window.</tr>
  112.      * <tr><td><i>name</i><td>Show in the frame or window named <i>name</i>. If 
  113.      *                        a target named <i>name</i> does not already exist, a 
  114.      *                        new top-level window with the specified name is created, 
  115.      *                        and the document is shown there.</tr>
  116.      * </table> </center>
  117.      * <p>
  118.      * An applet viewer or browser is free to ignore <code>showDocument</code>. 
  119.      *
  120.      * @param   url   an absolute URL giving the location of the document.
  121.      * @param   target   a <code>String</code> indicating where to display
  122.      *                   the page.
  123.      * @since   JDK1.0
  124.      */
  125.     public void showDocument(URL url, String target);
  126.  
  127.     /**
  128.      * Requests that the argument string be displayed in the 
  129.      * "status window". Many browsers and applet viewers 
  130.      * provide such a window, where the application can inform users of 
  131.      * its current state. 
  132.      *
  133.      * @param   status   a string to display in the status window.
  134.      * @since   JDK1.0
  135.      */
  136.     void showStatus(String status);
  137. }
  138.